Skip to content

Updates for Python Library API & model development placeholder#350

Merged
validbeck merged 6 commits intomainfrom
beck/sc-9191/add-new-validmind-for-model-validation-notebooks
Apr 9, 2025
Merged

Updates for Python Library API & model development placeholder#350
validbeck merged 6 commits intomainfrom
beck/sc-9191/add-new-validmind-for-model-validation-notebooks

Conversation

@validbeck
Copy link
Collaborator

Internal Notes for Reviewers

sc-9191

This is a sibling PR to validmind/documentation#689:

  • Updated the source for ValidMind Library > ValidMind Library API in our python API docs.
  • Updated the broken links to the renumbered model development series in the old intro for developers notebook (placeholder is validmind-library side only).

@validbeck validbeck added the internal Not to be externalized in the release notes label Apr 9, 2025
@validbeck validbeck self-assigned this Apr 9, 2025
@validbeck validbeck requested a review from nrichers April 9, 2025 22:01
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

˙sʇuǝɯɯoɔ pǝʇɐlǝɹ ʎɯ ǝǝS ˙(uoᴉʇɔǝɹᴉp ʍǝu ǝɥʇ sᴉ sᴉɥʇ ʇɐɥʇ ǝǝɹƃɐ puɐ uoᴉssnɔsᴉp ɹǝɥʇɹnɟ ɐ ǝʌɐɥ plnoɥs ǝʍ ɹo) ǝʇɐɹɐdǝs ʇdǝʞ ǝq plnoɥs ʇɐɥʇ sɯɹǝʇ ƃuᴉʇɐlɟuoɔ ʎq ʎƃolouᴉɯɹǝʇ uo uʍop ǝpᴉsdn sᴉ ɹԀ sᴉɥ┴

@nrichers
Copy link
Collaborator

nrichers commented Apr 9, 2025

@validbeck if you are OK with committing https://github.com/validmind/validmind-library/pull/350/files#r2036206897, I will approve this PR. We can also chat more about terminology at our standup.

validbeck and others added 2 commits April 9, 2025 16:02
Co-authored-by: Nik Richers <nik@validmind.ai>
@validbeck
Copy link
Collaborator Author

@nrichers Changed all the nebulous references to "ValidMind Library Python API", as even though that is a mouthful that is the most accurate description.

@validbeck validbeck requested a review from nrichers April 9, 2025 23:32
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚢

@github-actions
Copy link
Contributor

github-actions bot commented Apr 9, 2025

PR Summary

This pull request primarily focuses on updating the documentation and notebook metadata for the ValidMind Library. The changes include:

  1. Documentation Title Updates: The title in various documentation files has been updated from "ValidMind Library" to "ValidMind Library Python API". This change affects the following files:

    • docs/_sidebar.yml
    • docs/templates/module.qmd.jinja2
    • docs/templates/sidebar.qmd.jinja2
    • docs/validmind.qmd
  2. Notebook Metadata Enhancements: The metadata in the validate_application_scorecard.ipynb notebook has been updated to include a kernelspec section specifying the display name, language, and name of the kernel. Additionally, the Python version has been specified as 3.10.13.

  3. Tutorial Notebook Updates: The tutorial notebook intro_for_model_developers.ipynb has been updated to change the numbering format of the tutorial series from "101", "102", etc., to "1", "2", etc., for better readability and consistency.

  4. Version Bump: The version of the ValidMind Library has been incremented from 2.8.18 to 2.8.19 in pyproject.toml and validmind/__version__.py.

Test Suggestions

  • Verify that the documentation titles are correctly updated in the rendered documentation.
  • Check that the notebook validate_application_scorecard.ipynb runs without errors using the specified Python 3.10.13 kernel.
  • Ensure that the tutorial notebook intro_for_model_developers.ipynb displays the updated numbering format correctly.
  • Perform a regression test to ensure that the version bump does not introduce any new issues.

@validbeck validbeck merged commit 330d9c5 into main Apr 9, 2025
6 checks passed
@validbeck validbeck deleted the beck/sc-9191/add-new-validmind-for-model-validation-notebooks branch April 9, 2025 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants